Inside Macintosh: QuickDraw GX Objects /

Chapter 7 - View-Related Objects / View-Related Objects Reference

View Group Functions / Getting the View Ports and View Devices of a View Group

GXGetViewGroupViewDevices

You can use the GXGetViewGroupViewDevices function to retrieve a list of the view devices that are associated with a view group object.

long GXGetViewGroupViewDevices(gxViewGroup source, 
                                 gxViewDevice list[]);

source

A reference to the view group whose view devices you wish to examine.

list

An array of view device references. On return, the array contains a list of references to the view devices belonging to the source view group.

function result

The number of view device references in the list array.

DESCRIPTION

The GXGetViewGroupViewDevices function fills out a list of all the view devices in the source view group and returns, as its function result, the number of view devices
in the list.

If you pass gxAllViewDevices for the source parameter, this function returns all view devices in all view groups.

If you set the list parameter to nil, GXGetViewGroupViewDevices does not fill out the list of references; it only returns the number of view device references that would be in the list. Thus, you typically call this function twice: first to get the size of array to allocate for the list parameter, and second to retrieve the list itself.

ERRORS, WARNINGS, AND NOTICES

Errors
invalid_viewGroup_reference

SEE ALSO

For an example of the use of this function, see Listing 7-10 on page 7-54.

To get a list of all the view ports in a view group, use the GXGetViewGroupViewPorts function, described in the previous section.